Ft docs #327
Ft docs #327
Conversation
|
Hey @mr-c I just figured the images are not showing in this link that you pasted on gitter https://github.com/common-workflow-language/cwlviewer/pull/327/files?short_path=b335630#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5 And I don't really know what to call those buttons for cases where the image doesn't show |
README.md
Outdated
| java -agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5005 -Djava.security.egd=file:/dev/./urandom -jar /usr/lib/cwlviewer.jar | ||
|
|
||
|
|
||
| ####NB |
README.md
Outdated
|
|
||
| If the application is already running, do not run the debug configuration. Apply the settings and click Cancel. | ||
|
|
||
| ###3. Launch the debug configuration |
README.md
Outdated
| # CONNECTING JAVA DEBUGGER WITH DOCKER COMPOSE | ||
|
|
||
| Connecting to a java debugger can be broken down into the following steps: | ||
| ###1. Run the application using docker-compose |
There was a problem hiding this comment.
Needs a blank line between steps: and ###. Needs a space after ###
In other words:
Connecting to a java debugger can be broken down into the following steps:
### 1. Run the application using docker-compose
| - "5005:5005" | ||
| command: java -Djava.security.egd=file:/dev/./urandom -jar /usr/lib/cwlviewer.jar | ||
| ``` | ||
| If on intellij, open the docker-compose-debug.yml and click on the  in the gutter. |
There was a problem hiding this comment.
Could you put this under a heading like ### Using IntelliJ so it is clear these instructions are specific to that IDE.
There was a problem hiding this comment.
Hi @tetron, I've added the changes
There was a problem hiding this comment.
Docs well written, even including images, thanks! I left one comment about using docker-compose.override.yml which is already in our docs, instead of creating one for debug.
Also, I wonder if this section is really necessary? I debugged cwlviewer a couple days ago, but following the existing development instructions, I used the docker-compose.override.yml as documented, and executed the SpringBoot Java application from within IntelliJ.
This means I don't have to tell Docker to build from another image as in this docs, nor I have to wait for it to build it. I just start the application in Run mode, or in Debug mode.
I think I would only ever want to attach a remote debugger if I were to investigate an issue in an environment like test/prod/staging/uat/etc on whichever platform the viewer app is running, be it AWS, Azure, etc. Otherwise for development I would always follow the current instructions and debug the Java app separately (which means one-less-layer between my debugger and the code).
Just my 0.02 cents 👍
|
|
||
|
|
||
|
|
||
|
|
| @@ -201,6 +201,119 @@ The script `load.py` (requires Python 3) can be used to restore from such JSON d | |||
|
|
|||
| The optional parameter `--no-commits` can be added to skip those entries that | |||
| look like a commit ID. Note that this might break previous permalinks. | |||
|
|
|||
| # CONNECTING JAVA DEBUGGER WITH DOCKER COMPOSE USING INTELLIJ IDE | |||
There was a problem hiding this comment.
Use normal capitalization here? e.g. Connecting Java debugger with Docker Compose using IntelliJ IDE
|
|
||
| Once the application starts and the debugger attaches to it, the Debug tool window will open. | ||
|
|
||
| ### 4. Setting breakpoints and Debugging the application |
| ### 1. Run the application using docker-compose | ||
| Create a Dockerfile_debug at the root of the directory with the same content as the Dockerfile of the application | ||
|
|
||
| Create a docker-compose-debug.yml file with the same content as the docker-compose.yml file at the root of the directory replacing this in the docker-compose-debug.yml |
There was a problem hiding this comment.
Instead of docker-compose-debug.yml, maybe we would be able to use docker-compose.override.yml? I think the docs already mention it for running in development mode, so users & devs can just use that same file and add the extra debug steps if needed.
|
I think this can be closed. It's easier to debug it with the IDE locally, starting the DB & Fuseki only with docker compose. The readme contains information about docker compose already, and using that to debug should be straightforward to a Java developer (the IDE steps will vary a bit, but I think we shouldn't document it in our readme). |
Description
Motivation and Context
This change enables users working with cwlviewer and running the application with docker-compose to be able to connect the application to a java debugger on the local, inspect the containers and debug their application. #319How Has This Been Tested?
N/A N/A N/AScreenshots (if appropriate):
Types of changes
Checklist: